Skip to content

Updated user management docs — Renaming roles#285

Merged
validbeck merged 6 commits intomainfrom
beck/sc-5420/documentation-user-should-be-able-to-view
Aug 29, 2024
Merged

Updated user management docs — Renaming roles#285
validbeck merged 6 commits intomainfrom
beck/sc-5420/documentation-user-should-be-able-to-view

Conversation

@validbeck
Copy link
Collaborator

Internal Notes for Reviewers

For sc-5420, I updated the guides in "Managing users" to reflect new understanding of groups, roles, and permissions.

Managing users

The summary blurbs for guides under this section are now... informational! Instead of junk placeholder text that vaguely imply you should use these features for unclear purposes.

Old New
Screenshot 2024-08-28 at 11 15 44 AM Screenshot 2024-08-28 at 11 10 04 AM

Manage roles

Updated this to reflect the new ability to rename roles.

Old New
Screenshot 2024-08-28 at 11 17 14 AM Screenshot 2024-08-28 at 11 10 23 AM
... Screenshot 2024-08-28 at 11 10 30 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Aug 28, 2024
@validbeck validbeck self-assigned this Aug 28, 2024
@validbeck validbeck requested review from gtagle and nrichers August 28, 2024 18:19
@validbeck
Copy link
Collaborator Author

@gtagle Can I lean on you to confirm accuracy of the new blurbs? :)

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of minor suggested text tweaks but LGTM otherwise. 🚀

validbeck and others added 3 commits August 29, 2024 08:54
@github-actions
Copy link
Contributor

PR Summary

This pull request enhances the documentation for managing groups, permissions, roles, and users within the {{< var validmind.platform >}}. The changes provide clearer instructions and additional details to help users understand and manage access control more effectively.

Key Changes:

  1. Manage Groups:

    • Updated the description to clarify the purpose of groups and their role in access control.
    • Added a note that users must belong to a default group of All and can belong to multiple groups.
  2. Manage Permissions:

    • Clarified the role of permissions in user access control and their association with specific roles.
    • Emphasized the importance of aligning permissions with the role's intended responsibilities.
  3. Manage Roles:

    • Updated the description to define roles as a named set of permissions.
    • Added detailed steps for renaming existing roles.
    • Emphasized that the Customer Admin role has the highest level of access and cannot be modified.
  4. Manage Users:

    • Enhanced the description to include information about inviting new users and reviewing current users.
    • Clarified the relationship between users, groups, and roles.
  5. Register Models in Inventory:

    • Added a new field for selecting the group that can see the model if the user belongs to multiple groups.
    • Updated footnotes and references for better clarity.
  6. Training for Administrators:

    • Improved the description of assigning roles to users to better reflect organizational structure and feature access.

Test Suggestions

  • Verify that the updated documentation for managing groups accurately reflects the new descriptions and notes.
  • Check that the permissions documentation clearly explains the association between permissions and roles.
  • Ensure that the steps for renaming roles are correct and easy to follow.
  • Review the updated user management documentation to confirm it provides clear instructions on inviting and managing users.
  • Test the new field for selecting groups in the model registration process to ensure it functions as described.
  • Validate that all footnotes and references in the documentation are correct and lead to the appropriate sections.

@validbeck validbeck merged commit e9087c5 into main Aug 29, 2024
@validbeck validbeck deleted the beck/sc-5420/documentation-user-should-be-able-to-view branch August 29, 2024 16:05
github-actions bot added a commit that referenced this pull request Aug 29, 2024
* Deploy PR previews to branch folders (#284)

* Add PR preview deploy and delete to docs-demo site

* Re-add missing Makefile updates

* Remove --delete option from deploy-demo

* Update site/Makefile

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Tweak help wording

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Updated user management docs — Renaming roles (#285)

* Edits to summaries of docs under Managing users

* Added section for renaming roles

* Quick tweak to Register models for user groups

* Update site/guide/configuration/manage-permissions.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/guide/configuration/manage-roles.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Quick tweak, comma unification

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

---------

Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants